GetDataSourceParam

Definition:

GetDataSourceParam(datasource, paramname)

Description:

Obtain the current value of a specified configurable Data Source connection string parameter.

Platforms:

All

Parameters:

datasource - required

Specifies the Data Source to be acted on – click here for the format of this parameter.

paramname - required

String containing the name of the connection string parameter whose value you want to know.

Can have one of the following values:

"Username"

Username to be used to connect to the Target data source.

"Password"

Password to be used to connect to the Target data source.

"URL"

URL of a Web Service data source.

"Transaction"

Name of the Web Site Transaction to be used when connecting to an awi Web Service data source.

"ConnectionString" or "Connection"

Connection string when connecting to an ADO data source.

"Timeout"

Number of seconds the Digitise Apps Client will wait for data to start being downloaded when a data download is requested at runtime.

"Table"

The name of the remote database table when connecting to an ADO data source.

Returns:

String containing the current value of the specified parameter, or an empty string if this parameter hasn't previously been set using SetDataSourceParam and is using the default value.

Notes:

This Method, in conjunction with ClearDataSourceParams andSetDataSourceParam, allows you to programmatically modify the default connection string for the specified Data Source.

GetDataSourceParams allows you to query the current values set for the available parameters. You will need to call this Method separately for each parameter whose value you want to check. Any parameters not set within your Script will return an empty string and use the default values specified when the Data Source was defined during development of the Solution.

You can also change these connection values on the App Server using the App Manager utility, allowing you to easily modify the connection details without having to change your app.

This Method is not relevant for use with Custom Views.